home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / ladder35.zip / LADDERS.DOC < prev    next >
Text File  |  1992-12-25  |  21KB  |  461 lines
  1.  
  2.                              LADDERS   DICE
  3.  
  4.                                   v3.5
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.  
  13.  
  14.  
  15.  
  16.                                 OVERVIEW
  17.                                 ________
  18.  
  19.  
  20.    LADDERS DICE is a highly challenging, fast-paced, dice game that
  21.    requires some luck and good strategy. The object of the game is to
  22.    "capture" three ladders by reaching the top of the ladders, based
  23.    upon the roll of the dice.
  24.  
  25.  
  26.    NOTE: Most errors will be logged to a file called DFRAME.ERR, which is
  27.          created in the directory you run the door from.
  28.  
  29.  
  30.  
  31.                               INSTALLATION
  32.                               ____________
  33.  
  34.  
  35.    Installation is fairly easy and straight-forward. The following steps and
  36.    examples should have you up and running in a very short period of time.
  37.    It is assumed that you are familiar with setting up DOORS on your system.
  38.    To this end, only examples of the configuration file and Door batch file
  39.    are described.
  40.  
  41.       1) Create a directory to hold all LADDERS files
  42.  
  43.       2) Unzip LADDERxx.ZIP into the the above directory
  44.  
  45.       3) Create a configuration file, with a name of your choice, or
  46.          modify the supplied LADDERS.CFG file. A description follows:
  47.  
  48.             **                       Location of system file (See Below)
  49.             SUNRISE-80 BBS           Your BBS Name
  50.             Al                       Sysop's First name
  51.  
  52.             Lawrence                 Sysop's Last Name
  53.  
  54. |-----------------------------------------------------------------------------|
  55. | READ!     1                        CommPort  \ These 2 lines are required   |
  56. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  57. |-----------------------------------------------------------------------------|
  58.  
  59.             00000000                 Registration Number
  60.  
  61.     !   #   2                        Maximum # of Games per day
  62.                                      (Sysop get 99 in Registered verion ONLY!)
  63.  
  64.         #   0                        Max # of days a caller can make up, during
  65.                                      calls in one day. 0=Disable Make-up Option
  66.                                      Maximum value = 27, Minimum value = 1
  67.  
  68.         #   NONE                     Drive:\Path\Filename to contain the
  69.                                      Top Score Bulletin or enter NONE
  70.                                      for NO Bulletin creation.
  71.  
  72.         #   NONE                     Drive:\Path\Filename to contain the
  73.                                      Top Score Bulletin (Color) or enter NONE
  74.                                      for NO Bulletin creation.
  75.  
  76.         #   NONE                     Drive:\Path\Filename to contain the
  77.                                      Hall of Fame Bulletin or enter NONE
  78.                                      for NO Bulletin creation.
  79.  
  80.         #   NONE                     Drive:\Path\Filename to contain the
  81.                                      Hall of Fame Bulletin (Color) or enter NONE
  82.                                      for NO Bulletin creation.
  83.  
  84.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  85.                                      2 = Display ADOPT-A-DOOR message
  86.  
  87.         #   2                        Keyboard timeout value in Minutes
  88.  
  89.         #   3                        # of Ladders to Complete to Accumulate Pts
  90.                                      (Valid range is 1-12. Default = 3)
  91.  
  92.         #   50                   Pts to Deduct if HiScore >   100 & <   500
  93.         #   100                              "            >   499 & <  1000
  94.         #   300                              "            >   999 & <  4999
  95.         #   1000                             "            >  4999 & < 10000
  96.         #   2000                             "            >  9999 & < 20000
  97.         #   3000                             "            > 19999 & < 30000
  98.         #   5000                             "            > 29999 & < 40000
  99.         #   7000                             "            > 39999 & < 50000
  100.         #   9000                             "            > 49999 & < 60000
  101.         #   10000                            "            > 59999 & < 70000
  102.         #   15000                            "            > 69999
  103.  
  104.     !   #   0                        Time Allowed in Door
  105.                                      (Sysop = Time Remaining - REG. VERSION)
  106.  
  107.         #   N                        Automatic game reset at end of month:
  108.                                        Y = Yes enable autoreset
  109.                                        N = Keep accumulating scores
  110.  
  111.         #   Y                        Y = Allow Sysop to have 999 games
  112.                                      N = Do Not Allow Sysop 999 games
  113.  
  114.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  115.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  116.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  117.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  118.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  119.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  120.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  121.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  122.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  123.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  124.  
  125.     @   #   XXXX/YYYY                 Blackout Range  From/To
  126.     @   #   XXXX/YYYY                 Blackout Range  From/To
  127.     @   #   XXXX/YYYY                 Blackout Range  From/To
  128.     @   #   XXXX/YYYY                 Blackout Range  From/To
  129.     @   #   XXXX/YYYY                 Blackout Range  From/To
  130.  
  131.        ** = Replace with ONE of the following:
  132.  
  133. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  134. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  135. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  136.                                    (Note:DOOR.SYS must be in SAME directory)
  137. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  138. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  139. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  140. c:\bbs\TRIBBS>SYS               <- For TriBBS systems.
  141. C:\BBS\CHAIN.TXT                <- For WWIV systems
  142. C:\BBS\GTUSER.BBS               <- For GT Power
  143.                                    * if using this option you must put the
  144.                                      ComPort # on line 5 and the Node # on
  145.                                      line 6 of the configuration file
  146.  
  147.  
  148.  
  149.  
  150.        # = Requires registration to change to a different value.
  151.        ! = See "Plays Per Day" Below
  152.        @ = See "Blackout Periods" Below
  153.  
  154.                NOTE: There are NO Blank Lines in the Config File!!
  155.  
  156.  
  157.       4) Create a batch file or modify the LADDERS file supplied. A
  158.          description of this file follows:
  159.  
  160.             ECHO off
  161.             cd\BBS\DOORS\LADDERS      Location of Ladders files
  162.             LADDERS LADDERS.CFG       EXE filename and CNF filename (Name
  163.                                       used in creating file in #3 above)
  164.             CD\BBS
  165.             BOARD
  166.  
  167.  
  168.        5) When running in more than one node, be sure to supply a
  169.           different configuration name for each node (your choice of name).
  170.  
  171.        6) If running with Fossil-based multi-port boards add
  172.            /FD to the line containing the CFG name as follows:
  173.  
  174.                           LADDERS LADDERS.CFG /FD
  175.  
  176.  
  177.  
  178.                             POOL Points
  179.                             ------------
  180.  
  181. When you end up losing points, LADDERS will place them into a "POOL". This
  182. "POOL" will continue to accumulate all points lost by any player. It will
  183. also accumulate the points lost by those playing on any other node(s) at the
  184. same time. The "POOL" points will be updated on the players screen REAL TIME
  185. (at the moment the player on another node loses points). The "POOL" points
  186. can be won by any player, that wins the game by removing 3 Ladders, 2 of
  187. which MUST be the "2" and "12" Ladders. The minimum amount in the "POOL"
  188. will be 100 points.
  189.  
  190.  
  191.                           BLACKOUT PERIODS
  192.                           ________________
  193.  
  194.       Use the Blackout ranges option to define up to 5 time periods during
  195.       which you DO NOT want the Door to be played. If a caller tries to access
  196.       the Door during the Blackout period, they will be shown a message that
  197.       contains ALL the Blackout periods you have defined, and to try the Door
  198.       at a later time.
  199.  
  200.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  201.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  202.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  203.  
  204.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  205.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  206.                    a Blackout range.
  207.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  208.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  209.        NOTE: The deduction values, above, are the default values. The pgm
  210.              will check each value to ensure that it is equal to or greater
  211.              than the prior value. If it fails the check default values will
  212.              be used. If you do change the default values it will be your
  213.              reponsibility to edit the LADDERS.INS file and change the
  214.              deduction table contained within.
  215.  
  216.  
  217.                           PLAYS Per DAY/DOOR Time
  218.                           _______________________
  219.  
  220.       Plays Per Day and Door Time can be controlled several ways:
  221.  
  222.       (1) You can use the Games Per Day, singular option, in the config
  223.           file above. This option, will affect ALL callers whose Security
  224.           Level is NOT defined in any of the 10 optional Security Level/
  225.           Plays Per Day entries in the config file.
  226.  
  227.       (2) You can use the Door Time, singular option, in the config file
  228.           above. This option, will affect ALL callers whose Security
  229.           Level is NOT defined in any of the 10 optional Security Level/
  230.           Plays Per Day/Door Time entries in the config file.
  231.  
  232.       (3) You can restrict the number of games a specific Security Level
  233.           will be allowed to play per day or REWARD specific Levels with
  234.           more Plays Per Day.
  235.  
  236.           Likewise, you can restrict the Play time for a specific Security
  237.           Level or REWARD specific Levels with more Door Time.
  238.  
  239.           These options are handled by the use of the 10 config
  240.           entries (000=00/00).
  241.  
  242.           The format of each entry is as follows:
  243.  
  244.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  245.                      where =  is a constant and MUST be included
  246.                      where YY is the # of games per day (must be 2 digits)
  247.                      where / is a constant and MUST be included
  248.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  249.  
  250.           If the callers Security Level is NOT defined, his/her Plays Per
  251.           Day and Door Time will be controlled by the values in items
  252.           (1) and (2), above, respectively..
  253.  
  254.           You may define up to 10 Security Levels. All unused entries must
  255.           be defined as   000=00/00
  256.         --------------------------------------------------------------------
  257.           Example: Suppose you had 3 Security Levels defined on your BBS as
  258.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you
  259.           wanted to set Plays Per Day as :     Subscriber=5
  260.                                            Visiting Sysop=2
  261.                                                   CoSysop=3
  262.                                                    Friend=10
  263.  
  264.           and Door Time as follows:     Subscriber=30 minutes
  265.                                     Visiting Sysop=20 minutes
  266.                                            CoSysop=10 minutes
  267.                                             Friend=remaining call time
  268.  
  269.  
  270.           You would set the Individual "Games per Day" config entry to 1 and
  271.           the individual "Door Time" to 5 minutes (these would be the
  272.           default number of games and default Time for all Security Levels
  273.           other than 20,30 or 40... make them any number you want). Next you
  274.           would replace 4 of the Security Level entries as :  020=05/30
  275.                                                               030=02/20
  276.                                                               040=03/10
  277.                                                               090=10/0
  278.  
  279.  
  280.                         NON-STANDARD COM SUPPORT
  281.                         ________________________
  282.  
  283.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  284.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  285.       number after the configuration filename. Let's assume your Door is
  286.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  287.       passed to your Door would be:
  288.  
  289.                             FOOBAR FOOBAR.CFG /5
  290.  
  291.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  292.       normally used with COM1. No /x parameter is needed for the standard
  293.       IRQ's.
  294.  
  295.       As an alternative, you may use an environmental variable on the command
  296.       line. To use the variable (following the example above), place a
  297.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a
  298.       different IRQ number for each node). The command line would now look
  299.       like this:
  300.  
  301.                           FOOBAR FOOBAR.CFG /%IRQ%
  302.  
  303.       This, in combination with the use of the environmental variables
  304.       described in the MULTI-NODE SETUP section will allow you to use one
  305.       batch file and one config file to run this door on all nodes.
  306.  
  307.  
  308.  
  309.  
  310.                            MULTI-NODE SETUP
  311.                            ________________
  312.  
  313.       All Sunrise Doors are Multi-Node capable. Each node must have the
  314.       ability to access a configuration file which will have its own system
  315.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first
  316.       line. There are 2 ways to accomplish this:
  317.  
  318.       (1) Create a separate configuration file for each node. The only
  319.           difference between each file would be the location of the system
  320.           file for that particular node. For example, on my system there are 2
  321.           nodes and the first line of the config files would look like this:
  322.  
  323.                         NODE1:  H:\PCB1\DOOR.SYS
  324.                         NODE2:  H:\PCB2\DOOR.SYS
  325.  
  326.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  327.  
  328.       (2) Use ONE configuration file for ALL nodes. This Door will recognize
  329.           the following PCBoard environmental variables:
  330.  
  331.                  PCBDIR    (Directory containing the System file)
  332.                  PCBDRIVE  (Drive containing the System file)
  333.  
  334.           Thus, the first line of the SINGLE configuration file, for this Door
  335.           would look like this:
  336.  
  337.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  338.  
  339.       NOTE: This option, as described, assumes that you are running PCBoard
  340.             14.5a software. The environmental variables are automatically
  341.             created by the software for each node.
  342.  
  343.             HOWEVER, if you are running other BBS software you should be able
  344.             to set the variables EXACTLY as described below, for EACH node
  345.             (more than likely in each batch file you use to bring up EACH node):
  346.  
  347.                             PCBDRIVE=C:
  348.                             ^^^^^^^^^
  349.                             PCBDIR=\NODE2
  350.                             ^^^^^^^^
  351.  
  352.             Info with a carat (^) under it, MUST be typed as is. The rest
  353.             depends on your naming conventions.
  354.  
  355.             This, in combination with the use of the optional environmental
  356.             variable described in the NON-STANDARD COM SUPPORT section, will
  357.             allow you to use one batch file and one config file to run this
  358.             door on all nodes.
  359.  
  360.  
  361.  
  362.                                ADOPT-A-DOOR
  363.                                ____________
  364.  
  365.     Having been a Sysop for a number of years, I have had my share of problems
  366.     and frustrations getting financial support for my board's upkeep. A fellow
  367.     Sysop left a message on my board, not long ago, about a concept that was
  368.     being used by several boards around the country.
  369.  
  370.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  371.     would be the same as sending in a donation, only this way it is earmarked
  372.     for registering a particular door. In a way, the user feels he/she is
  373.     "getting something in return". As a Door author I have decided to build
  374.     this concept into each of my Door programs. The concept replaces the
  375.     usual message "tell the Sysop to register this Door" we find in most
  376.     doors.
  377.  
  378.     If the Door is unregisterd then a message appears on the opening screen
  379.     to that effect. After finishing or suspending a game, a message screen
  380.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  381.     caller to contact the Sysop to find out if there is any further details
  382.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  383.     time, etc to callers that ADOPT-A-DOOR.
  384.  
  385.     If the Door has been registered, either by the Sysop or other callers,
  386.     the names of those contributors will be displayed in the closing screen.
  387.  
  388.     NOTE: If you want to display the names of the callers that contributed
  389.           to registering the Door, you must create an ASCII file called
  390.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  391.           the name(s) of the contributors (one on each line, maximum of 5
  392.           entries, each a maximum of 30 characters long). This file must be
  393.           saved, in ASCII format, and placed in the Door directory.
  394.  
  395.  
  396.  
  397.                               LEGALITIES
  398.                               __________
  399.  
  400.  
  401.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  402.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  403.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  404.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  405.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  406.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  407.       OR BREACH OF ANY WARRANTY.
  408.  
  409.  
  410.  
  411.  
  412.  
  413.                              DISTRIBUTION
  414.                              ____________
  415.  
  416.    You may make this file available for downloading from your BBS or you may
  417.    upload it to any BBS of your choice, provided that you do not make any
  418.    changes to the contents of the archive (ZIP file). The archive and its
  419.    individual contents may not be used by any service that charges any money
  420.    whatsoever, without the written permission of the author.
  421.  
  422.  
  423.  
  424.  
  425.  
  426.                              REGISTRATION
  427.                              ____________
  428.  
  429.    Registration and the subsequent insertion of the registration number into
  430.    your configuation file, allows for the display of your BBS name on the
  431.    opening and closing screen as well as the reduction of a delay built into
  432.    the opening screen display along with the ability to change certain
  433.    values in the configuration file.
  434.  
  435.    To register your copy of LADDERS, please fill out the registration form
  436.    (REGISTER.FRM) and mail it along with registration fee to
  437.    the name and address on the form.
  438.  
  439.    Be sure to use the proper upper/lower case when filling in your name and
  440.    BBS name, as they MUST match the way you entered them in the configuration
  441.    file.             ^^^^
  442.  
  443.    Based upon information supplied on the registration form, I will pre-
  444.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  445.    up your registration number.
  446.  
  447.  
  448.  
  449.                                  MISC
  450.                                  ____
  451.  
  452.    The latest version of LADDERS Dice and other fine SUNRISE DOOR programs
  453.    are always available for download from SUNRISE-80 BBS.
  454.  
  455.    Remember, should you have any problems, questions or suggestions, be sure
  456.    to drop me a message on Sunrise-80 or you can reach me through the
  457.    PCRELAY/RIME network in the BBS Doors, Sysops, PCBHints or through a R/O
  458.    to    ->SUNRISE
  459.  
  460.  
  461.